Repository navigation
Template 0.1.38: merged and corrected guides from the docs audit - #62
Merged
Merged
Conversation
…e==version Version ranges appear only in a requirements.yaml edited directly on GitHub; the merge keeps and combines them, so the later section no longer reads as a contradiction. Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com> Claude-Session: https://claude.ai/code/session_01WX6rdRdA72nsUjZvTXFSbP
…, expiry and revoking Step 9 names the initialiser, the upload form and the Welcome notebook / first-cell version check of a private repository; before_getting_started lists the token in its requirements (initialise_repository already links the page where the token is first needed). Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com> Claude-Session: https://claude.ai/code/session_01WX6rdRdA72nsUjZvTXFSbP
App users cannot see the template version: each fix says to install the newest release of the app; deleting the personal kernel folder becomes an advanced step after it. Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com> Claude-Session: https://claude.ai/code/session_01WX6rdRdA72nsUjZvTXFSbP
… page for app users Merges the website's hand-written "Open and use an app" page: open the app, the Welcome notebook, run a notebook (code hiding shown with the toolbar pictures), the app's example, napari/Fiji/QuPath, results, Colab, update, close, and where to look when something fails. Links outside the template docs are absolute website links. install.md, executable_creation.md and the docs README use the new title. Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com> Claude-Session: https://claude.ai/code/session_01WX6rdRdA72nsUjZvTXFSbP
… app up to date" keep_app_up_to_date.md is merged into template_synchronization.md (the name more links point to: sync_template.yml, the README, troubleshooting, the 0.1.12 migration, the website) and becomes a short pointer page that leaves the docs README. app_manifest, create_repository, executable_creation and troubleshooting link the merged page; the footers follow the index. Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com> Claude-Session: https://claude.ai/code/session_01WX6rdRdA72nsUjZvTXFSbP
executable_creation checks distribution.platforms and that every workflow run is green before the release, and links Submit your app; tools_bridge drops "(optional)" from its title (it opens the Connect track); app_manifest says windows-arm64 / linux-arm64 build nothing yet; notebook_upload: "through" -> "throw". Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com> Claude-Session: https://claude.ai/code/session_01WX6rdRdA72nsUjZvTXFSbP
v0_1_37_to_v0_1_38.py replaces sixteen files of .tools/docs whole, only when the app's copy is still the 0.1.37 template file (LF comparison, the app's line endings kept, SKIPPED otherwise, nothing created or deleted). keep_app_up_to_date.md becomes the pointer page and the docs README drops it only when they are the 0.1.37 template copies; a skipped one gets a note of what to change by hand. external_code_upload.md is also recognised with the app's package name. Resources: the new pages and previous/ (the 0.1.37 pages). Design note migration_0_1_38.md (not listed in the index). Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com> Claude-Session: https://claude.ai/code/session_01WX6rdRdA72nsUjZvTXFSbP
…_1_38.py) before_0_1_38 gives the frozen 0.1.37 copy of a file that is the 0.1.38 page; it is chained into before_0_1_37, and the 0.1.20, 0.1.21 and 0.1.37 tests use it where they read a live guide. Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com> Claude-Session: https://claude.ai/code/session_01WX6rdRdA72nsUjZvTXFSbP
Resources are the live files and differ from the frozen 0.1.37 copies; a 0.1.37 app reaches the live files (LF and CRLF kept) and a second run changes nothing; a customised guide, the pointer page and the docs README written by the form are SKIPPED (the last two with a note of what to change by hand); external_code_upload.md with the package name; missing files are not created; sync.py from 0.1.37 and the chain from 0.1.36. Also checks the first-run page, the one update page and its pointer, no template versions for app users, the token page, the tools guide title, the footers and the relative links. Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com> Claude-Session: https://claude.ai/code/session_01WX6rdRdA72nsUjZvTXFSbP
… app Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com> Claude-Session: https://claude.ai/code/session_01WX6rdRdA72nsUjZvTXFSbP
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Docs audit follow-up, phase 1 items 4–6 and phase 2 items 9–11 and 14.
Guides (
.tools/docs)package==version, and that ranges appear only in a requirements.yaml edited on GitHub.repotoken is needed (ghp_), the expiry, and a new "Renew or revoke" section. before_getting_started lists the token.Migration 0.1.37 → 0.1.38: files are replaced whole only when they are still the 0.1.37 copy, otherwise SKIPPED with a by-hand note. Nothing is created or deleted. Design note:
.tools/docs/migration_0_1_38.md.Tests:
tests/_v0_1_38.py(before_0_1_38), chained frombefore_0_1_37, plustests/test_template_sync_0_1_38.py. The full suite passes locally (2 skipped); mypy and ruff (CI version) are clean.Generated by Claude Code